# EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University
# of Illinois, The Regents of the University of California, through Lawrence
# Berkeley National Laboratory (subject to receipt of any required approvals
# from the U.S. Dept. of Energy), Oak Ridge National Laboratory, managed by UT-
# Battelle, Alliance for Sustainable Energy, LLC, and other contributors. All
# rights reserved.
#
# NOTICE: This Software was developed under funding from the U.S. Department of
# Energy and the U.S. Government consequently retains certain rights. As such,
# the U.S. Government has been granted for itself and others acting on its
# behalf a paid-up, nonexclusive, irrevocable, worldwide license in the
# Software to reproduce, distribute copies to the public, prepare derivative
# works, and perform publicly and display publicly, and to permit others to do
# so.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# (1) Redistributions of source code must retain the above copyright notice,
#     this list of conditions and the following disclaimer.
#
# (2) Redistributions in binary form must reproduce the above copyright notice,
#     this list of conditions and the following disclaimer in the documentation
#     and/or other materials provided with the distribution.
#
# (3) Neither the name of the University of California, Lawrence Berkeley
#     National Laboratory, the University of Illinois, U.S. Dept. of Energy nor
#     the names of its contributors may be used to endorse or promote products
#     derived from this software without specific prior written permission.
#
# (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in
#     stand-alone form without changes from the version obtained under this
#     License, or (ii) Licensee makes a reference solely to the software
#     portion of its product, Licensee must refer to the software as
#     "EnergyPlus version X" software, where "X" is the version number Licensee
#     obtained under this License and may not use a different name for the
#     software. Except as specifically required in this Section (4), Licensee
#     shall not use in a company name, a product name, in advertising,
#     publicity, or other promotional activities any name, trade name,
#     trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or
#     confusingly similar designation, without the U.S. Department of Energy's
#     prior written consent.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

import unittest

from pyenergyplus.api import EnergyPlusAPI
from pyenergyplus.common import EnergyPlusException

api = EnergyPlusAPI()


class TestPythonAPITypes(unittest.TestCase):
    """
    py.test on EnergyPlusAPI.exchange functions to see type checking in action
    """

    def setUp(self):
        self.state = api.state_manager.new_state()

    def test_get_actuator_handle(self):

        self.assertEqual(
            api.exchange.get_actuator_handle(self.state, "Weather Data", "Outdoor Dew Point", "Environment"), -1
        )

        # Wrong number of arguments
        with self.assertRaises(TypeError) as cm:
            api.exchange.get_actuator_handle(self.state, "Weather Data", "Outdoor Dew Point")
        self.assertIn("get_actuator_handle() missing 1 required positional argument: 'actuator_key'", str(cm.exception))

        with self.assertRaises(EnergyPlusException) as cm:
            api.exchange.get_actuator_handle(self.state, 1, "Outdoor Dew Point", "Environment")
            self.assertIn(
                "`get_actuator_handle` expects `component_type` as a `str` or UTF-8 encoded `bytes`, not '1'",
                str(cm.exception),
            )

        with self.assertRaises(EnergyPlusException) as cm:
            api.exchange.get_actuator_handle(self.state, "Weather Data", 2, "Environment")
            self.assertIn(
                "`get_actuator_handle` expects `control_type` as a `str` or UTF-8 encoded `bytes`, not '2'",
                str(cm.exception),
            )

        with self.assertRaises(EnergyPlusException) as cm:
            api.exchange.get_actuator_handle(self.state, "Weather Data", "Outdoor Dew Point", 3)
            self.assertIn(
                "`get_actuator_handle` expects `actuator_key` as a `str` or UTF-8 encoded `bytes`, not '3'",
                str(cm.exception),
            )

    def test_get_variable_value(self):
        self.assertEqual(api.exchange.get_variable_value(self.state, -1), 0.0)

        with self.assertRaises(TypeError) as cm:
            api.exchange.get_variable_value(self.state)
            self.assertIn(
                "get_variable_value() missing 1 required positional argument: 'variable_handle'", str(cm.exception)
            )

        with self.assertRaises(EnergyPlusException) as cm:
            api.exchange.get_variable_value(self.state, "foo")
            self.assertIn(
                "`get_variable_value` expects `variable_handle` as a `str` or UTF-8 encoded `bytes`, not 'foo'",
                str(cm.exception),
            )


if __name__ == "__main__":
    unittest.main()
